feat(instrumentation-pg): add skipConnectSpans option #3280
+83
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a configuration option to skip creating `pg.connect` and `pg-pool.connect` spans while preserving query spans and pool metrics. This helps reduce trace noise in high-throughput scenarios where connection time is not of interest. - Add `skipConnectSpans?: boolean` to PgInstrumentationConfig - Skip span creation for both client and pool connect operations - Still set up event listeners for pool metrics when skipping spans - Add tests for new option - Update README with new option documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
Contributor
|
can you also add a changelog for this? https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-pg/CHANGELOG.md |
maryliag
reviewed
Dec 10, 2025
Contributor
maryliag
left a comment
maryliag
left a comment
There was a problem hiding this comment.
Adding a name suggestion, following the name convention we use in other instrumentations: skip for internal functions, and ignore on user facing configuration (e.g. ignoreResolveSpans)
| | `responseHook` | `PgInstrumentationExecutionResponseHook` (function) | Function for adding custom span attributes from db response | | ||
| | `requireParentSpan` | `boolean` | If true, requires a parent span to create new spans (default false) | | ||
| | `addSqlCommenterCommentToQueries` | `boolean` | If true, adds [sqlcommenter](https://github.com/open-telemetry/opentelemetry-sqlcommenter) specification compliant comment to queries with tracing context (default false). _NOTE: A comment will not be added to queries that already contain `--` or `/* ... */` in them, even if these are not actually part of comments_ | | ||
| | `skipConnectSpans` | `boolean` | If true, `pg.connect` and `pg-pool.connect` spans will not be created. Query spans and pool metrics are still recorded (default false) | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `skipConnectSpans` | `boolean` | If true, `pg.connect` and `pg-pool.connect` spans will not be created. Query spans and pool metrics are still recorded (default false) | | |
| | `ignoreConnectSpans` | `boolean` | If true, `pg.connect` and `pg-pool.connect` spans will not be created. Query spans and pool metrics are still recorded (default false) | |
| if (utils.shouldSkipInstrumentation(plugin.getConfig())) { | ||
| const config = plugin.getConfig(); | ||
|
|
||
| if (utils.shouldSkipInstrumentation(config) || config.skipConnectSpans) { |
Contributor
There was a problem hiding this comment.
Suggested change
| if (utils.shouldSkipInstrumentation(config) || config.skipConnectSpans) { | |
| if (utils.shouldSkipInstrumentation(config) || config.ignoreConnectSpans) { |
| // Still set up event listeners for metrics even when skipping spans | ||
| plugin._setPoolConnectEventListeners(this); | ||
|
|
||
| if (config.skipConnectSpans) { |
Contributor
There was a problem hiding this comment.
Suggested change
| if (config.skipConnectSpans) { | |
| if (config.ignoreConnectSpans) { |
| * | ||
| * @default false | ||
| */ | ||
| skipConnectSpans?: boolean; |
Contributor
There was a problem hiding this comment.
Suggested change
| skipConnectSpans?: boolean; | |
| ignoreConnectSpans?: boolean; |
| assert.strictEqual(spans.length, 0); | ||
| }); | ||
|
|
||
| it('should not create connect spans when skipConnectSpans=true', async () => { |
Contributor
There was a problem hiding this comment.
Suggested change
| it('should not create connect spans when skipConnectSpans=true', async () => { | |
| it('should not create connect spans when ignoreConnectSpans=true', async () => { |
| it('should not create connect spans when skipConnectSpans=true', async () => { | ||
| const newPool = new pgPool(CONFIG); | ||
| create({ | ||
| skipConnectSpans: true, |
Contributor
There was a problem hiding this comment.
Suggested change
| skipConnectSpans: true, | |
| ignoreConnectSpans: true, |
| assert.ok(querySpans.length > 0, 'Expected query spans to be created'); | ||
| }); | ||
|
|
||
| it('should still record pool metrics when skipConnectSpans=true', async () => { |
Contributor
There was a problem hiding this comment.
Suggested change
| it('should still record pool metrics when skipConnectSpans=true', async () => { | |
| it('should still record pool metrics when ignoreConnectSpans=true', async () => { |
| const metricReader = testUtils.initMeterProvider(instrumentation); | ||
| const newPool = new pgPool(CONFIG); | ||
| create({ | ||
| skipConnectSpans: true, |
Contributor
There was a problem hiding this comment.
Suggested change
| skipConnectSpans: true, | |
| ignoreConnectSpans: true, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
skipConnectSpansconfiguration option to skip creatingpg.connectandpg-pool.connectspansBackground
The
pg.connectandpg-pool.connectspans measure connection time but provide limited actionable insight in many scenarios:Changes
skipConnectSpans?: booleantoPgInstrumentationConfig(defaultfalse)_getClientConnectPatch()and_getPoolConnectPatch()when enabled_setPoolConnectEventListeners()to preserve pool metricsTest plan
skipConnectSpans=trueverifying no connect spans are created🤖 Generated with Claude Code